Foxit PDF SDK
Public Member Functions | Static Public Attributes | List of all members
FoxitPDFSDKPython2.AutoTagProviderCallback Class Reference

Inherits FoxitPDFSDKPython2._object.

Public Member Functions

def GetReportText (type)
 Get the display text for an auto tag result data type.
More...
 

Static Public Attributes

 e_AutoTagResultDataTypeAlttext = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeAlttext
 Auto tag result data type: alttext.

 
 e_AutoTagResultDataTypeArtifacts = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeArtifacts
 Auto tag result data type: artifacts.

 
 e_AutoTagResultDataTypeBacktotop = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeBacktotop
 Auto tag result data type: back to top.

 
 e_AutoTagResultDataTypeCheckCategory = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeCheckCategory
 Auto tag result data type: check category.

 
 e_AutoTagResultDataTypeCheckerTable5 = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeCheckerTable5
 Auto tag result data type: checker table 5.

 
 e_AutoTagResultDataTypeFigures = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeFigures
 Auto tag result data type: figures.

 
 e_AutoTagResultDataTypeFixCategory = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeFixCategory
 Auto tag result data type: fix category.

 
 e_AutoTagResultDataTypeHighConfidence = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeHighConfidence
 Auto tag result data type: high confidence.

 
 e_AutoTagResultDataTypeHintAlttext = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeHintAlttext
 Auto tag result data type: hint alttext.

 
 e_AutoTagResultDataTypeHintArtifacts = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeHintArtifacts
 Auto tag result data type: hint artifacts.

 
 e_AutoTagResultDataTypeHintFigure = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeHintFigure
 Auto tag result data type: hint figure.

 
 e_AutoTagResultDataTypeHintList = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeHintList
 Auto tag result data type: hint list.

 
 e_AutoTagResultDataTypeHintParagraph = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeHintParagraph
 Auto tag result data type: hint paragraph.

 
 e_AutoTagResultDataTypeHintRegion = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeHintRegion
 Auto tag result data type: hint region.

 
 e_AutoTagResultDataTypeHintRepair = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeHintRepair
 Auto tag result data type: hint repair.

 
 e_AutoTagResultDataTypeHintTableHeader = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeHintTableHeader
 Auto tag result data type: hint tableheader.

 
 e_AutoTagResultDataTypeHintTableRow = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeHintTableRow
 Auto tag result data type: hint tablerow.

 
 e_AutoTagResultDataTypeHintTables = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeHintTables
 Auto tag result data type: hint tables.

 
 e_AutoTagResultDataTypeHintToc = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeHintToc
 Auto tag result data type: hint toc.

 
 e_AutoTagResultDataTypeIntroduction = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeIntroduction
 Auto tag result data type: introduction.

 
 e_AutoTagResultDataTypeListItem = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeListItem
 Auto tag result data type: listitem.

 
 e_AutoTagResultDataTypeLowConfidence = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeLowConfidence
 Auto tag result data type: low confidence.

 
 e_AutoTagResultDataTypeMediumConfidence = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeMediumConfidence
 Auto tag result data type: medium confidence.

 
 e_AutoTagResultDataTypeMediumhighConfidence = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeMediumhighConfidence
 Auto tag result data type: mediumhigh confidence.

 
 e_AutoTagResultDataTypeMediumlowConfidence = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeMediumlowConfidence
 Auto tag result data type: mediumlow confidence.

 
 e_AutoTagResultDataTypeMissFigure = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeMissFigure
 Auto tag result data type: miss figure.

 
 e_AutoTagResultDataTypePage = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypePage
 Auto tag result data type: page.

 
 e_AutoTagResultDataTypeParagraphs = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeParagraphs
 Auto tag result data type: paragraphs.

 
 e_AutoTagResultDataTypeReduceConfidence = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeReduceConfidence
 Auto tag result data type: reduce confidence.

 
 e_AutoTagResultDataTypeRegions = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeRegions
 Auto tag result data type: regions.

 
 e_AutoTagResultDataTypeRibbonCategory = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeRibbonCategory
 Auto tag result data type: ribbon category.

 
 e_AutoTagResultDataTypeSumAlttextFigure = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeSumAlttextFigure
 Auto tag result data type: sum alttext figure.

 
 e_AutoTagResultDataTypeSumReduceConfidence = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeSumReduceConfidence
 Auto tag result data type: sum reduce confidence.

 
 e_AutoTagResultDataTypeTableHeader = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeTableHeader
 Auto tag result data type: table header.

 
 e_AutoTagResultDataTypeTableRow = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeTableRow
 Auto tag result data type: table row.

 
 e_AutoTagResultDataTypeTables = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeTables
 Auto tag result data type: tables.

 
 e_AutoTagResultDataTypeTagrepIntroduction = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeTagrepIntroduction
 Auto tag result data type: tagrep introduction.

 
 e_AutoTagResultDataTypeTagreportFilename = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeTagreportFilename
 Auto tag result data type: tagreport filename.

 
 e_AutoTagResultDataTypeTagreportNextpage = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeTagreportNextpage
 Auto tag result data type: tagreport nextpage.

 
 e_AutoTagResultDataTypeTagreportPrepage = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeTagreportPrepage
 Auto tag result data type: tagreport prepage.

 
 e_AutoTagResultDataTypeToc = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeToc
 Auto tag result data type: toc.

 
 e_AutoTagResultDataTypeTouchupReadingOrder = _fsdk.AutoTagProviderCallback_e_AutoTagResultDataTypeTouchupReadingOrder
 Auto tag result data type: touchup reading order.

 

Detailed Description

This class represents an auto tag results provider for accessibility.

All the pure virtual functions in this class are used as callback functions and should be implemented by user in derived class.

Member Function Documentation

◆ GetReportText()

def FoxitPDFSDKPython2.AutoTagProviderCallback.GetReportText (   type)

Get the display text for an auto tag result data type.

This callback is invoked by the SDK while it generates the "Add Tags" report during auto tagging. For each result data type (see ), the SDK requests the corresponding (typically localized) display string from the application, so the application controls all user-visible wording in the report.

Most types map to a plain label (for example "Figures", "Artifacts", "Table Summary"). A few types expect the returned string to contain a printf-style placeholder that the SDK substitutes at runtime; the implementation must keep the placeholder and its order intact:

  • %d page number (1-based): e_AutoTagResultDataTypePage ("Page \%d"), e_AutoTagResultDataTypeMissFigure ("Figure missing AltText on page \%d.");
  • %d count: e_AutoTagResultDataTypeSumReduceConfidence ("\%d reduced confidence pages"), e_AutoTagResultDataTypeSumAlttextFigure ("\%d figures missing AltText");
  • %ls category name: e_AutoTagResultDataTypeCheckCategory ("\%ls to check."), e_AutoTagResultDataTypeFixCategory ("How to Fix \%ls Tagging.");
  • %ls file name: e_AutoTagResultDataTypeTagreportFilename ("Add Tags Report for \%ls").

Return an empty string for an unknown or unhandled type.

Parameters
[in]typeOne value of the enumeration, that the SDK is requesting text for.
Returns
The display text for type (may contain a placeholder as noted above), or an empty string if the type is not handled.